API Documentation
Public Member Functions | List of all members
nkWinUi::Window Class Referenceabstract

A graphical window. More...

Inheritance diagram for nkWinUi::Window:
nkWinUi::Component nkExport::Exportable

Public Member Functions

 Window ()
 
 ~Window ()
 
virtual bool isMaximized () const
 
virtual bool isFullscreen () const
 
void setClickCallback (const mouseClickCallback &value)
 
virtual void setIcon (const nkImages::ImageView &icon)=0
 
virtual void maximize (bool val, bool coverTaskBar=false)=0
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
ThemegetTheme () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getAreaInParent () const
 
nkMaths::Rectangle getAreaInScreen () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
nkMemory::StringView getComponentName () const
 
bool getVisibility () const
 
virtual nkMemory::StringView getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setTheme (Theme *theme)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setAreaInParent (const nkMaths::Rectangle &area)
 
virtual void setAreaInScreen (const nkMaths::Rectangle &area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const nkMemory::StringView &label)
 
void setComponentName (const nkMemory::StringView &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage (bool withFrame=false)
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical window.

Constructor & Destructor Documentation

◆ Window()

nkWinUi::Window::Window ( )

Constructor.

Remarks
See ComponentManager::createOrRetrieve().

◆ ~Window()

nkWinUi::Window::~Window ( )

Destructor.

Member Function Documentation

◆ isMaximized()

virtual bool nkWinUi::Window::isMaximized ( ) const
virtual
Returns
Whether the window is maximized (covering the whole screen surface, true) or not (false).

◆ isFullscreen()

virtual bool nkWinUi::Window::isFullscreen ( ) const
virtual
Returns
Whether the window is fullscreen. A window is fullscreen if it covers the screen it is on, task bar included.

◆ setClickCallback()

void nkWinUi::Window::setClickCallback ( const mouseClickCallback value)

Sets the callback called when a click occurs in the window.

Parameters
valueThe callback to set.

◆ setIcon()

virtual void nkWinUi::Window::setIcon ( const nkImages::ImageView icon)
pure virtual

Sets the icon to use for the window, both in its title bar and in the task bar.

Parameters
iconThe image to use as an icon.

◆ maximize()

virtual void nkWinUi::Window::maximize ( bool  val,
bool  coverTaskBar = false 
)
pure virtual

Maximizes the window.

Parameters
valIf the window should be maximized (true) or minimized (false).
coverTaskBarWhether the task bar should be covered (true) or not (false), when maximizing the window.

◆ exportIntrospection()

virtual void nkWinUi::Window::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::Window::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: